@bcoe/v8-coverage

What is @bcoe/v8-coverage?

@bcoe/v8-coverage is a Node.js package that provides tools for working with V8 JavaScript engine's code coverage data. It allows you to parse, manipulate, and format coverage data generated by V8, which is useful for analyzing code coverage in JavaScript applications.

What are @bcoe/v8-coverage's main functionalities?

Parsing V8 Coverage Data

This feature allows you to parse raw V8 coverage data into a more manageable format. The code sample demonstrates how to use the `parse` function to convert raw coverage data into a parsed format.

const { parse } = require('@bcoe/v8-coverage');
const coverageData = [
  {
    result: [
      {
        scriptId: '1',
        url: 'file.js',
        functions: [
          {
            functionName: 'foo',
            ranges: [
              { startOffset: 0, endOffset: 10, count: 1 }
            ],
            isBlockCoverage: true
          }
        ]
      }
    ]
  }
];
const parsedData = parse(coverageData);
console.log(parsedData);

Merging Coverage Data

This feature allows you to merge multiple sets of V8 coverage data into a single set. The code sample demonstrates how to use the `mergeProcessCovs` function to combine two sets of coverage data.

const { mergeProcessCovs } = require('@bcoe/v8-coverage');
const coverageData1 = [
  {
    result: [
      {
        scriptId: '1',
        url: 'file.js',
        functions: [
          {
            functionName: 'foo',
            ranges: [
              { startOffset: 0, endOffset: 10, count: 1 }
            ],
            isBlockCoverage: true
          }
        ]
      }
    ]
  }
];
const coverageData2 = [
  {
    result: [
      {
        scriptId: '1',
        url: 'file.js',
        functions: [
          {
            functionName: 'foo',
            ranges: [
              { startOffset: 0, endOffset: 10, count: 2 }
            ],
            isBlockCoverage: true
          }
        ]
      }
    ]
  }
];
const mergedData = mergeProcessCovs([coverageData1, coverageData2]);
console.log(mergedData);

Formatting Coverage Data

This feature allows you to format V8 coverage data into a JSON object. The code sample demonstrates how to use the `CoverageMap` class to create a coverage map and then format it as a JSON object.

const { CoverageMap } = require('@bcoe/v8-coverage');
const coverageData = [
  {
    result: [
      {
        scriptId: '1',
        url: 'file.js',
        functions: [
          {
            functionName: 'foo',
            ranges: [
              { startOffset: 0, endOffset: 10, count: 1 }
            ],
            isBlockCoverage: true
          }
        ]
      }
    ]
  }
];
const coverageMap = new CoverageMap(coverageData);
const formattedData = coverageMap.toJSON();
console.log(formattedData);

Other packages similar to @bcoe/v8-coverage

istanbul-lib-coverage

istanbul-lib-coverage is a library for working with code coverage data in Istanbul, a popular JavaScript code coverage tool. It provides similar functionalities for manipulating and merging coverage data, but it is designed to work with Istanbul's coverage format rather than V8's.

nyc

nyc is a command-line tool for generating code coverage reports for JavaScript applications. It uses Istanbul under the hood and provides a higher-level interface for running tests and generating coverage reports. While it does not directly manipulate V8 coverage data, it can be used in conjunction with tools like @bcoe/v8-coverage to generate comprehensive coverage reports.

c8

c8 is a code coverage tool that uses V8's built-in coverage reporting. It provides a simple interface for running tests and generating coverage reports using V8's coverage data. It is similar to @bcoe/v8-coverage in that it works directly with V8's coverage format, but it is more focused on providing a complete coverage reporting solution.

README

V8 Coverage

License

MIT License